FlowPosition
Represents a workflow position in the system, encapsulating properties and methods to manage the workflow step logic.
Properties
| Name | Description |
|---|---|
| MessageOptions | Gets or sets the message options. |
| NotificationOptions | Gets or sets the push notification options. |
| Id | The unique identifier of the flow position. |
| Key | A unique identifier for the workflow step. |
| MailMessage | Gets the mail message associated with the message. |
| WorkflowCodeInstance | The workflow code instance associated with the flow object. |
| CachedDMObjects | The cached document management objects related to the flow object. |
| DoNotSendRequestIfProcessed | Indicates whether a request should be avoided if already processed. |
| NotificationCaption | Gets the notification caption associated with the message. |
| NotificationMessage | Gets the notification message associated with the message. |
| HideApporoverInHistory | Determines whether the approver should be hidden in the flow history. |
| AutoOpenApprovalOption | Automatically opens approval options for the current position. |
| IsCustomMailMessage | Gets or sets a value indicating whether the mail message is custom. |
| MailSubject | Gets the mail subject associated with the message. |
| GeolocationOptions | Geolocation-related options for the flow position. |
| EnableSendMail | Gets or sets a value indicating whether sending mail is enabled. |
| TypeCode | The type code associated with the flow object. |
| ForwardingOptions | Options defining forwarding behavior for the flow position. |
| EventsToCheck | A list of event names to monitor for the flow position. |
| ValueType | Indicates the type of the flow position, such as user or initiator. |
| TimeoutHour | The number of hours set for the timeout duration. |
| RequestIsNecessaryIfDocumentChanged | Requires approval if the associated document has been modified. |
| TimeoutDuration | The total timeout duration in a TimeSpan format. |
| Attachments | Gets the list of attachments associated with the message. |
| WebNotificationOptions | Gets or sets the web notification options. |
| Description | A descriptive name for the flow position, often combining first and last names. |
| TimeoutOptions | Options defining the timeout behavior for the flow position. |
| TimeoutDay | The number of days set for the timeout duration. |
| Name | Name for the workflow step. |
| CalculateUsingWorkingHours | Specifies if working hours should be considered in timeout calculations. |
| The email address linked to the current flow position. | |
| Documents | A list of documents associated with the flow position. |
| Events | A read-only list of events related to the flow position. |
| EnablePushNotification | Gets or sets a value indicating whether push notification is enabled. |
| CustomMailMessage | Gets the custom mail message associated with the message. |
| TimeoutMinute | The number of minutes set for the timeout duration. |
| ShowInFlowHistory | Specifies if the position should be visible in the flow history. |
| CalculateUsingHolidays | Specifies if holiday calculations should be included in timeouts. |
| Caption | The caption dictionary representing localized captions for the flow object. |
| Code | The code associated with the flow position, typically representing a username. |
Constructors
| Name | Description |
|---|---|
| FlowPosition(name, workflowData, workflowCodeInstance) | Constructor for the FlowPosition class. Initializes a new instance of the FlowPosition class. |
| FlowPosition(name, workflowData, workflowCodeInstance) | Initializes a new instance of the FlowPosition class with a name, workflow data, and workflow code instance. |
| FlowPosition(name,workflowData,workflowCodeInstance) | Initializes a new instance of the FlowPosition class. |
Methods
| Name | Description |
|---|---|
| SetPositionFromVariable(sourceVariable, sourceProperty) | Assigns a position to the flow position based on a variable and source property. |
| SetReferredUser(user) | Sets a referred user for the flow position. |
| SetManagerUserAccordingToProfession(managerKey, professionName, targetPosition, sourcePosition, titleType, flowAssign) | Sets a manager user for the flow position according to profession criteria. |
| GetUserInfo() | Retrieves the user information for the flow position. |
| SetConstantPosition(id, code, description) | Assigns a constant position to the flow position. |
| SetFromUser(userId) | Assigns a user to the flow position based on the user ID. |
| SetFromPosition(positionId) | Assigns a position to the flow position based on the position ID. |
| SetUserFromVariable(sourceVariable) | Assigns a user to the flow position based on a variable. |
| SetUserFromImpersonatingUser() | Sets the flow position user from the impersonating user. |
| SetConstantPosition(constantPosition) | Assigns a constant position to the flow position using another flow position. |
| Initialize() | Initializes the flow position with default settings. |
| SetUserFromFlowInitiator() | Sets the flow position user from the flow initiator. |
| GetUserInfoWithPositionId() | Retrieves the user information along with the position ID for the flow position. |
| AddAttachment(value,type) | Adds an attachment to the mail message. |
| SetManagerUserFromUser(managerProfile, sourcePosition) | Assigns a manager user to the flow position based on a manager profile. |
| RemoveDocument(flowDocument) | Removes a document from the flow position. |
| AddDocument(flowDocument, viewName, viewId, panelSize, allowEdit, showEvents) | Adds a document to the flow position with optional view and display settings. |
| SendPushNotification(userInfo,requestItem) | Sends a push notification to a user. |
| SetUserFromFlowInitiatorManager(managerKey) | Sets the flow position user from the flow initiator's manager. |
| SendApprovalWebNotification(userInfo, requestItem) | Sends a web notification for approval based on the provided process request and user information. |
| SendRequestTimedOutWebNotification(userInfo, requestItem) | #import (Bimser.CSP.Workflow.Api.Steps.FlowGroup.SendRequestTimedOutWebNotification(UserInfo,ProcessRequestItem)) (shortDescription) |
| ToLiquid() | Converts the flow position into a format compatible with Liquid templates. |
| SetUserFromLogonUser() | Sets the flow position user from the currently logged-on user. |
| SetVariablePosition(position) | Assigns a variable position to the flow position using another flow position. |
| SetConstantUser(id, userName, fullName) | Assigns a constant user to the flow position. |
| SendMail(requestItem, userInfo) | Sends an email notification based on the provided process request and user information. |
| SetDepartmentManagerUserFromDepartment(sourceDepartment) | Sets a department manager user for the flow position based on a department. |
| SendWebNotification(payloadType,userInfo,requestItem) | Sends a web notification to a user. |
Events
| Name | Description |
|---|---|
| OnBeforeExecution(sender, args) | Occurs before the execution of the workflow step. |
| OnAfterExecution(sender, args) | Occurs after the execution of the workflow step. |
Generic Types
| Name | Description |
|---|---|
| TProperties | Generic type of properties. |